The Source Control Integration API > The source control integration API optional functions > SCS_Checkout()

 

SCS_Checkout()

Description

Checks out a list of local files or folders from the source control system. The DLL is responsible for granting the privileges that allow the file to be writeable. If unsupported by the source control system and this feature is enabled by the user, uses the Dreamweaver internal checkin/out functionality, which transports .lck files to/from the source control system.

Arguments

connectionData, remotePathList, localPathList, successList, numItems

connectionData is a pointer to the agent's data that was passed into Dreamweaver during the Connect() call.
remotePathList is a list of fully qualified remote file or folder paths to check out.
localPathList is a mirrored list of fully qualified local file or folder paths.
successList is a list of Boolean values populated by the DLL to let Dreamweaver know which of the corresponding files was successfully checked out.
numItems is the number of items in each list.

Returns

true if successful, false if not.